Package com.cisco.pt.ipc.sim.impl
Class OSPFAreaImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.OSPFAreaImpl
Information provided by the PKI file:
\class OspfArea
\brief OspfArea handles and manipulates OSPF areas.
\example network().getDevice("Router0").getProcess("OspfMainProcess").getOspfProcessAt(0).getAreaAt(0)
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionOSPFAreaImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionInformation provided by the PKI file:Information provided by the PKI file:getConfiguredNetworkAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:intgetFloodLength(String portName) Information provided by the PKI file:intgetLastFloodLength(String portName) Information provided by the PKI file:intgetLastFloodTime(String portName) Information provided by the PKI file:intgetMaxFloodLength(String portName) Information provided by the PKI file:intgetMaxFloodTime(String portName) Information provided by the PKI file:getNeighborTable(String portName) Information provided by the PKI file:intInformation provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
OSPFAreaImpl
public OSPFAreaImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getAreaId
Information provided by the PKI file:
\brief Returns the OSPF area ID. \param ip, the OSPF area ID. -
setAuthentication
Information provided by the PKI file:
\brief Sets the OSPF authentication type. \param type, the OSPF authentication type. Authentication types: eNoAuth = 0, eAuth = 1, eMD5Auth = 2- Specified by:
setAuthenticationin interfaceOSPFArea- Parameters:
type- Takes in a parameter of type
-
getAuthentication
Information provided by the PKI file:
\brief Returns the OSPF authentication type. \return OspfAuthType, the OSPF authentication type. Authentication types: eNoAuth = 0, eAuth = 1, eMD5Auth = 2- Specified by:
getAuthenticationin interfaceOSPFArea- Returns:
- OSPFAuthType Returns a OSPFAuthType
-
getConfiguredPortCount
public int getConfiguredPortCount()Information provided by the PKI file:
\brief Returns the number of configured ports. \return int, the number of configured ports.- Specified by:
getConfiguredPortCountin interfaceOSPFArea- Returns:
- int Returns a int
-
getConfiguredNetworkCount
public int getConfiguredNetworkCount()Information provided by the PKI file:
\brief Returns the number of configured networks. \return int, the number of configured networks.- Specified by:
getConfiguredNetworkCountin interfaceOSPFArea- Returns:
- int Returns a int
-
getConfiguredNetworkAt
Information provided by the PKI file:
\brief Returns the network address and subnet mask at the specified index. \param index, the index of the network address and subnet mask of interest. \return pair<ip, ip>, the network address and subnet mask at the specified index.- Specified by:
getConfiguredNetworkAtin interfaceOSPFArea- Parameters:
index- Takes in a parameter of index- Returns:
- Pair<IPAddress, IPAddress> Returns a Pair<IPAddress, IPAddress>
-
getNeighborTable
Information provided by the PKI file:
\brief Returns the OSPF neighbor table of the specifed port. \param portName, portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return OspfNeighborTable, the OspfNeighborTable object of the specifed port.- Specified by:
getNeighborTablein interfaceOSPFArea- Parameters:
portName- Takes in a parameter of portName- Returns:
- OSPFNeighborTable Returns a OSPFNeighborTable
-
getDatabase
Information provided by the PKI file:
\brief Return the OSPF database. \return OspfDatabase, the OspfDatabase object.- Specified by:
getDatabasein interfaceOSPFArea- Returns:
- OSPFDatabase Returns a OSPFDatabase
-
getFloodLength
Information provided by the PKI file:
\brief Returns the flood length of the specified port. \param portName portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return int, the flood length of the specified port.- Specified by:
getFloodLengthin interfaceOSPFArea- Parameters:
portName- Takes in a parameter of portName- Returns:
- int Returns a int
-
getLastFloodLength
Information provided by the PKI file:
\brief Returns the last flood length of the specified port. \param portName portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return int, the last flood length of the specified port.- Specified by:
getLastFloodLengthin interfaceOSPFArea- Parameters:
portName- Takes in a parameter of portName- Returns:
- int Returns a int
-
getLastFloodTime
Information provided by the PKI file:
\brief Returns the last flood time of the specified port. \param portName portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return int, the last flood time of the specified port.- Specified by:
getLastFloodTimein interfaceOSPFArea- Parameters:
portName- Takes in a parameter of portName- Returns:
- int Returns a int
-
getMaxFloodLength
Information provided by the PKI file:
\brief Returns the maximum flood length of the specified port. \param portName portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return int, the maximum flood length of the specified port.- Specified by:
getMaxFloodLengthin interfaceOSPFArea- Parameters:
portName- Takes in a parameter of portName- Returns:
- int Returns a int
-
getMaxFloodTime
Information provided by the PKI file:
\brief Returns the maximum flood time of the specified port. \param portName portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return int, the maximum flood time of the specified port.- Specified by:
getMaxFloodTimein interfaceOSPFArea- Parameters:
portName- Takes in a parameter of portName- Returns:
- int Returns a int
-
getSpfCount
public int getSpfCount()Information provided by the PKI file:
\brief Returns the number of shortest paths. \return int, the number of shortest paths.- Specified by:
getSpfCountin interfaceOSPFArea- Returns:
- int Returns a int
-